home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / spnge310.zip / SPONGE.DOC < prev    next >
Text File  |  1991-04-07  |  23KB  |  488 lines

  1.  
  2.  
  3.         SPONGE: v3.10                                     by Stephen de Plater
  4.         April 7, 1991                                GT Network Address: 302/1
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                                         SPONGE
  13.                                  by Stephen de Plater
  14.                                GT Network Address: 302/1
  15.                               Voice Phone: +61 2 977-3075
  16.                               Data Phone: +61 2 977-2013
  17.  
  18.  
  19.  
  20.         ======================================================================
  21.         0.                           REVISION LIST
  22.         ======================================================================
  23.  
  24.         VERSION:  Release Date:       Comments:
  25.         -------   ------------        --------------------------------------
  26.         1.00      September 9, 1988   First Release.
  27.  
  28.         2.10      April 20, 1990      GT15 version with new features.  Warning
  29.                                       messages  are  now  issued,  logging  is
  30.                                       changed,  and   three  new  substitution
  31.                                       characters are defined.
  32.  
  33.         2.11      June 29, 1990       Minor  bug  fix:  SPONGE   was  properly
  34.                                       handling   numbers   (for   really   BIG
  35.                                       downloaders!) greater than 16 bit signed
  36.                                       integers  (32767),  but was  incorrectly
  37.                                       printing them!  FIXED.  Also,  ported to
  38.                                       the new compiler (Turbo C++).
  39.  
  40.         3.00      October 23, 1990    GT16 version *ONLY*.   This version will
  41.                                       NOT run  with versions  of  GT prior  to
  42.                                       GT16.    There are  no other  changes in
  43.                                       this version.
  44.  
  45.         3.01      November 7, 1990    A small change  to accomodate VERY  long
  46.                                       lines in the SYSOP.BBS.  The limit there
  47.                                       (for   sponge   anyway)   is   now   254
  48.                                       characters per line.
  49.  
  50.         3.10      April 7, 1991       Now  allows  the  two levels  to  be the
  51.                                       same!   Why? So that a  WARNING only may
  52.                                       be issued.  Used  when you don't want to
  53.  
  54.  
  55.                                      >> page 1 <<
  56.  
  57.         SPONGE: v3.10                                     by Stephen de Plater
  58.         April 7, 1991                                GT Network Address: 302/1
  59.  
  60.  
  61.  
  62.                                       actually  change anyone's  access level,
  63.                                       but remind them that they are  getting a
  64.                                       bit heavy handed with the downloads.
  65.  
  66.  
  67.         ======================================================================
  68.         1.                             COPYRIGHT
  69.         ======================================================================
  70.  
  71.         SPONGE is not  placed in the Public Domain. The  copyright is retained
  72.         and the software is provided on licence:
  73.  
  74.         You are free  to use and  make as many copies  of this program  as you
  75.         wish. You may also give it away to anyone who wants it, provided:
  76.  
  77.         1.   No fee is charged.
  78.         2.   This archive is distributed intact.
  79.         3.   You register the package with an OZNET registration centre.
  80.  
  81.  
  82.         ======================================================================
  83.         2.                           REGISTRATION
  84.         ======================================================================
  85.  
  86.         A  new  registration  scheme  now   applies  to  all  OZNET  software.
  87.         Regardless  of any  previous registration,  this program  now requires
  88.         individual installation for each BBS using it.
  89.  
  90.         There  is  still NO  fee  involved  at all.  DO  NOT  send any  money!
  91.         Registration  simply  involves obtaining  from  me  a CRC  code  which
  92.         matches  your  BBS  name.    You  may do  this  at  any  of  the OZNET
  93.         registration centres:
  94.  
  95.                   Kangaroo Korner          302/001   Stephen de Plater
  96.                   The Black Hole           302/003   Ken Thompson
  97.                   Control Systems          071/001   Ed Cavender
  98.                   Gidget's Domain          081/005   Jack Hazel
  99.                   Fuzzy Logic              050/018   Phill Piddell
  100.                   Geno's Place             044/003   Gene Newcomb
  101.                   InfoStation              032/001   Perry Alexander
  102.  
  103.         If you are in the GT nodelist then you will be able to register direct
  104.         online at  any of those  centres or via  mail in  the correct form  to
  105.         OZRobot  at any of  those centres.  See  the included OZRobot document
  106.         for details.  If you are not in  the GT net you will need to apply via
  107.  
  108.  
  109.                                      >> page 2 <<
  110.  
  111.         SPONGE: v3.10                                     by Stephen de Plater
  112.         April 7, 1991                                GT Network Address: 302/1
  113.  
  114.  
  115.  
  116.         private netmail or message to  Sysop at any of the centres.   Whatever
  117.         way you do it you  will need to supply the full  (case sensitive) name
  118.         to which you want the program registered.
  119.  
  120.         You will also need  to obtain the OZINSTAL program which  performs the
  121.         actual  installation.  OZINSTAL is not  included in this archive.  You
  122.         should look for OZINST11.ZIP.
  123.  
  124.  
  125.         ======================================================================
  126.         3.                              PURPOSE
  127.         ======================================================================
  128.  
  129.                          (Or what does this thing do anyway?)
  130.  
  131.         SPONGE is a  companion program for GT  Power BBS Systems. It  monitors
  132.         the  relative amounts of uploads and  downloads by users of your board
  133.         and, as  controlled by the  SPONGE.BBS file, can  automatically change
  134.         their access level when  downloads become excessive. It will  also (if
  135.         you do not inhibit  it) automatically restore their old  access levels
  136.         once the ratio has been achieved.
  137.  
  138.         Version  2.10 and  later will also  warn users  when they  are getting
  139.         close.
  140.  
  141.  
  142.         ======================================================================
  143.         4.                               USAGE
  144.         ======================================================================
  145.  
  146.         To use SPONGE  simply install  it in your  GTLOGOFF.BAT file.   Please
  147.         note that  the usage for v2+  is totally different from  that of v1.x.
  148.         GT v14 and below did not keep in the user file the count of  files and
  149.         kilobytes uploaded and downloaded.  GT15 does.  There is  therefore no
  150.         longer  any need  to  generate these  figures  with the  old  RATIOGEN
  151.         program.  You may consign that one to a NUL device!
  152.  
  153.         When SPONGE runs it  looks up the details for the  last user (which is
  154.         why  it is run in the  logoff batch), and checks their upload/download
  155.         counts.  If they have  exceeded their limit (either in base  amount or
  156.         in  ratio) then  they are downgraded.   Optionally they  may be warned
  157.         when  they are  approaching the  limit and  given a  chance  to upload
  158.         something  before sponging takes place.   Also optionally  they may be
  159.         automatically upgraded  when enough  uploads have occurred  to restore
  160.         their ratio to an acceptable level.
  161.  
  162.  
  163.                                      >> page 3 <<
  164.  
  165.         SPONGE: v3.10                                     by Stephen de Plater
  166.         April 7, 1991                                GT Network Address: 302/1
  167.  
  168.  
  169.  
  170.         The parameters are optional and function as follows:
  171.  
  172.         1.   /S   The name of the  sponge control file. This file  must reside
  173.                   in   your  GTPATH   directory.   The  default   filename  is
  174.                   "SPONGE.BBS." If you  use this name  then this parameter  is
  175.                   unnecessary.
  176.  
  177.                   This  ASCII  file contains  one line  for each  access level
  178.                   which is to be  subject to sponge checking (only  the levels
  179.                   listed  in this file will ever be checked). The vertical bar
  180.                   character "|"  is the field delimiter.  The following fields
  181.                   MUST be present in each record:
  182.  
  183.                   (a)  Access  Level  to   be  monitored   for  changes   (one
  184.                        character),
  185.                   (b)  Access Level to to change users to (one character),
  186.  
  187.                        THESE LEVELS *MUST* BE UNIQUE PAIRS!
  188.                        That is, you CANNOT have something like:
  189.  
  190.                        --------------------------------------
  191.                        A|X|.....
  192.                        B|X|.....
  193.                        --------------------------------------
  194.  
  195.                        SPONGE   will  become   totally  confused   and  behave
  196.                        irrationally  if you do that kind of thing!  You should
  197.                        instead have something like:
  198.  
  199.                        --------------------------------------
  200.                        A|X|.....
  201.                        B|Y|.....
  202.                        --------------------------------------
  203.  
  204.                   (c)  The amount of  downloads permitted before ratios  begin
  205.                        to apply (integer) in KBytes,
  206.                   (d)  The ratio  (n.n:1) which  applies to each  user's whole
  207.                        download:upload record  after the  amount in  (c) above
  208.                        has been passed. This is a SINGLE floating point number
  209.                        and MUST contain a decimal point.
  210.  
  211.                        i.e: to  set a  ratio of  20:1 use "20.0"   DO  NOT use
  212.                        "20:1" or "20.0:1"!!!
  213.  
  214.  
  215.  
  216.  
  217.                                      >> page 4 <<
  218.  
  219.         SPONGE: v3.10                                     by Stephen de Plater
  220.         April 7, 1991                                GT Network Address: 302/1
  221.  
  222.  
  223.  
  224.                   (e)  The  name  of the  file (which  must  be in  the GTPATH
  225.                        directory) which  contains  the message  which will  be
  226.                        sent to  each downgraded  user by the  program. Various
  227.                        escaped characters will be substituted as shown below.
  228.  
  229.                   (f)  The  name  of the  file (which  must  be in  the GTPATH
  230.                        directory)  which  contains the  message which  will be
  231.                        sent to each UPGRADED user by the program. The same set
  232.                        of escaped characters will be used.
  233.  
  234.                   (g)  The  name  of the  file (which  must  be in  the GTPATH
  235.                        directory)  which contains  the  warning message  which
  236.                        will  be sent  when a  user is  getting close  to being
  237.                        sponged.
  238.  
  239.                   (h)  The  level at which the warning message will be sent. I
  240.                        use  90% (entered here as  "0.90") but you  can use any
  241.                        amount  you like.  It obviously only makes sense to use
  242.                        numbers  between  0 and  1.    You  can have  different
  243.                        warning levels for each line in the SPONGE.BBS.
  244.  
  245.                        NOTE: fields (g) and (h) above are optional.  If (g) is
  246.                        present, then (h) MUST also be present.  If (g)  is not
  247.                        present, then no warnings will be given.
  248.  
  249.                   For example,  at Kangaroo  Korner, Privileged  users (access
  250.                   level  'P') are allowed 2000 KBytes  before ratios come into
  251.                   effect and then are  allowed a ratio of 30:1.  Regular users
  252.                   (access level 'R') are allowed 1000 KBytes before a ratio of
  253.                   20:1  comes into effect. In both cases the access level will
  254.                   be reduced: 'P' goes to  'Q' and 'R' to 'S' and  the message
  255.                   which  will  be  placed  in  the  default  message  area for
  256.                   downgraded users will come from file DOWN.MSG.
  257.  
  258.                   When appropriate ratios have been restored, the message from
  259.                   file  UP.MSG will  be issued  and the  access level  will be
  260.                   reset.
  261.  
  262.                   When users  are within 90%  of being sponged (that  is: if a
  263.                   regular user is below 1,000k but above 900k, with not enough
  264.                   uploads  to keep their ratio  above 20:1, or  when a regular
  265.                   has some  upload credits but their ratio is approaching 20:1
  266.                   (in fact closer than  18:1), then a warning message  will be
  267.                   issued.   No change of  access level occurs  with a warning,
  268.  
  269.  
  270.  
  271.                                      >> page 5 <<
  272.  
  273.         SPONGE: v3.10                                     by Stephen de Plater
  274.         April 7, 1991                                GT Network Address: 302/1
  275.  
  276.  
  277.  
  278.                   the user is  just reminded  that they are  getting close  to
  279.                   being sponged.
  280.  
  281.                   The SPONGE.BBS  control file  at Kangaroo Korner  looks like
  282.                   this:
  283.  
  284.                        --------------------------------------------------
  285.                        P|Q|2000|30.0|down.msg|up.msg|warn.msg|0.90
  286.                        R|S|1000|20.0|down.msg|up.msg|warn.msg|0.90
  287.                        --------------------------------------------------
  288.  
  289.                   In  addition, when  any user's  access level  is changed  by
  290.                   SPONGE, the change is logged to the GT.LOG.
  291.  
  292.         2.   /I   Not  only will  the program  downgrade errant users,  but it
  293.                   will also  automatically upgrade  them again when  they have
  294.                   uploaded enough material to bring their  ratio into line. If
  295.                   you do not wish the program to do this (if you want to do it
  296.                   all yourself)  then the /I parameter  will inhibit automatic
  297.                   upgrades.  Automatic downgrades  will still be  performed in
  298.                   all cases however.
  299.  
  300.         The  command line  options must  be separated  by white  space, (i.e.:
  301.         "/Ssponge.bbs/Rratio.bbs" is not valid, but "/Ssponge.bbs /Rratio.bbs"
  302.         is). They may  be in either upper  or lower case, and  supplied in any
  303.         order.  Also, you  may  use  the '-'  character  as  the command  line
  304.         parameter flag instead  of '/'. In either case there  must be NO space
  305.         between  the /S  (or /R)  and the  filename. (i.e.:  "-Ssponge.bbs" is
  306.         fine.)
  307.  
  308.  
  309.         ======================================================================
  310.         5.                       ESCAPED SUBSTITUTIONS
  311.         ======================================================================
  312.  
  313.         In  the message files  which is named  in fields (e), (f),  and (g) on
  314.         each line of  the SPONGE.BBS  file, the following  characters will  be
  315.         replaced  according to the list below when they follow (immediately) a
  316.         percent character. Case is irrelevant.
  317.  
  318.                   %N   is replaced with the full name of the current user.
  319.                   %F   is  replaced with  the first  name only of  the current
  320.                        user.
  321.                   %U   is replaced with the  level of Uploads for  the current
  322.                        user.
  323.  
  324.  
  325.                                      >> page 6 <<
  326.  
  327.         SPONGE: v3.10                                     by Stephen de Plater
  328.         April 7, 1991                                GT Network Address: 302/1
  329.  
  330.  
  331.  
  332.                   %D   is replaced with the level of Downloads.
  333.                   %R   is replaced  with  the download:upload  ratio  for  the
  334.                        current user.
  335.                   %K   is  replaced  with the  amount  of  downloads at  which
  336.                        ratios begin to apply for the current user,
  337.                   %T   is replaced with the ratio which must be maintained for
  338.                        the access level of the current user.
  339.                   %H   is replaced by the access level  which the current user
  340.                        is being downgraded from.
  341.                   %L   is  replaced by the access level which the current user
  342.                        is being downgraded to.
  343.                   %I   is replaced by the number of files uploaded.
  344.                   %O   (the letter not the number)  is replaced by the  number
  345.                        of files downloaded.
  346.                   %W   is  replaced  by the  warning  percentage  level.   For
  347.                        instance, here I use 90%, entered into field (h) in the
  348.                        SPONGE.BBS line as "0.90".  In this case %W is replaced
  349.                        by "90%".
  350.                   %%   is replaced by a single percent sign ('%').
  351.  
  352.         A sample downgrade message file is shown below
  353.  
  354.         --------------------------------------------------------------------
  355.         %F
  356.          
  357.         Records kept at Kangaroo Korner show that your downloads are becoming 
  358.         excessive! So far you have downloaded %D kbytes in %O files
  359.         and only uploaded %U kbytes in %I files.
  360.  
  361.         That gives a dl:ul ratio of %R. 
  362.          
  363.         For your level of access you are allowed %K kbytes before ratios 
  364.         come into effect. After that the maximum ratio allowed is %T. 
  365.          
  366.         You have therefore been downgraded from level %H to %L and your 
  367.         download privileges have been withdrawn. This has been an automatic 
  368.         process initiated by the BBS itself. 
  369.          
  370.         When  your uploads  reach  an acceptable  level  your access  will  be
  371.         restored. 
  372.         --------------------------------------------------------------------
  373.  
  374.         NOTE  that the  substitution process  is quite  unsophisticated. If  a
  375.         substitution would take any  line of the message beyond  80 characters
  376.  
  377.  
  378.  
  379.                                      >> page 7 <<
  380.  
  381.         SPONGE: v3.10                                     by Stephen de Plater
  382.         April 7, 1991                                GT Network Address: 302/1
  383.  
  384.  
  385.  
  386.         NO word  wrap will  be performed --  it is  up to  you to design  your
  387.         message in such a way that it should not happen.
  388.  
  389.         NOTE ALSO:  For the automatic upgrades to work, the two levels on each
  390.         line in the  SPONGE.BBS file should be  in unique matched pairs.  That
  391.         is, do  not have two  different levels downgrading  users to  the same
  392.         lower level. I  downgrade from two levels, P=Privilege  down to Q, and
  393.         R=Regular down  to S. As upgrades  are only performed  from the second
  394.         level in each line of the SPONGE.BBS file to the first level, there is
  395.         no ambiguity. Those at level S can only be upgraded to R, and those at
  396.         level Q can  only be upgraded  to P. Only  one line in  the SPONGE.BBS
  397.         file is required for each pair. On this system the Q and S levels have
  398.         exactly  the same times and  privileges as P  and R respectively, with
  399.         the one exception that download permission has been witheld from them.
  400.  
  401.         WARNING ONLY
  402.         ============
  403.  
  404.         If the two levels are  identical, then no change of access  level will
  405.         be performed.  However,  if a warning is  appropriate, then a  warning
  406.         message  will be issued.   This is  useful for those  who want to give
  407.         users a gentle reminder  that perhaps they are abusing  the friendship
  408.         somewhat, but not actually change their access level.  One application
  409.         is  for boards which have  a paid "membership"  level, where users are
  410.         not subject to ratios, but who still want to automatically warn people
  411.         who only ever take without giving.  Perhaps an extra line like the top
  412.         one   in  the  control  file  below  might  be  appropriate  in  those
  413.         circumstances.  Notice that you still need to specify  ALL the message
  414.         files, even though you only ever want to warn people.  In this example
  415.         they are all the same file.
  416.  
  417.                        --------------------------------------------------
  418.                        M|M|5000|30.0|memb.msg|memb.msg|memb.msg|1.00
  419.                        P|Q|2000|30.0|down.msg|up.msg|warn.msg|0.90
  420.                        R|S|1000|20.0|down.msg|up.msg|warn.msg|0.90
  421.                        --------------------------------------------------
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.                                      >> page 8 <<
  434.  
  435.         SPONGE: v3.10                                     by Stephen de Plater
  436.         April 7, 1991                                GT Network Address: 302/1
  437.  
  438.  
  439.  
  440.         ======================================================================
  441.         6.                            DISCLAIMER
  442.         ======================================================================
  443.  
  444.         Q:         What kind of guarantee comes with this software?
  445.  
  446.         A:                    *** ABSOLUTELY NONE!!! ***
  447.  
  448.         If you break it, you get to keep both parts.
  449.  
  450.         I take no responsibility  at all for what this software may  do on any
  451.         computer other than my own. If you use it you do so at your  own risk.
  452.         All that I am prepared to say about it is that it works fine here (and
  453.         I can see no good reason  why it should not also work fine  everywhere
  454.         else also -- but ....)
  455.  
  456.         By using this program you accept these conditions.
  457.  
  458.  
  459.         ======================================================================
  460.         7.                              ENJOY!
  461.         ======================================================================
  462.  
  463.         At least, I hope you do!
  464.         Stephen
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.                                      >> page 9 <<
  488.